Skip to content

Include Channel Name in server log#206

Open
NicoPiel wants to merge 24 commits intoOpenIntegrationEngine:mainfrom
NicoPiel:feature/logging-improvements
Open

Include Channel Name in server log#206
NicoPiel wants to merge 24 commits intoOpenIntegrationEngine:mainfrom
NicoPiel:feature/logging-improvements

Conversation

@NicoPiel
Copy link
Collaborator

@NicoPiel NicoPiel commented Nov 19, 2025 •
edited
Loading

Changelog:

  1. Server:

    • Modified ServerLogItem to include channelName, updated constructor, getters/setters.
    • Modified ServerLogProvider to pass channelName to ServerLogItem.
    • Modified ArrayAppender to extract channelName and channelId from Log4j ThreadContext.
    • Modified JavaScriptTask to populate ThreadContext with channel info.

  2. Donkey Engine:

    • Modified Channel to populate ThreadContext in dispatch and source queue threads.
    • Modified DestinationChain to populate ThreadContext using channel info.
    • Modified DestinationConnector to populate ThreadContext in queue threads.

  3. Client:

    • Modified ServerLogPanel to add "Channel" column to the UI table.

mgaffigan
mgaffigan requested changes Nov 19, 2025
View reviewed changes
mgaffigan
mgaffigan requested changes Nov 19, 2025
View reviewed changes
@NicoPiel NicoPiel force-pushed the feature/logging-improvements branch from 9fce32c to 3c94136 Compare November 20, 2025 14:13
@NicoPiel
Copy link
Collaborator Author

NicoPiel commented Nov 24, 2025

@mgaffigan Thoughts on the map implementation? Did you have this in mind when you suggested a map?

@NicoPiel @mgaffigan
Working channelName in the CLI, client UI not updating
28d08a1 
Signed-off-by: Nico Piel <nicopiel@mailbox.org>
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Channel Columns in the UI works
34dbab0 
Signed-off-by: Nico Piel <nicopiel@mailbox.org>
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Line breaks
1260098 
Signed-off-by: Nico Piel <nicopiel@mailbox.org>
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
getOrDefault
b42783f 
Signed-off-by: Nico Piel <nicopiel@mailbox.org>
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Implemented Builder Pattern
bcee58d 
Signed-off-by: Nico Piel <nicopiel@mailbox.org>
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Use CloseableThreadContext
2b555d7 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Have to add this line to include the new Builder pattern internal class
2d118e4 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Implemented a HashMap instead
88c452b 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
CloseableThreadContext where applicable
790a60e 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Reverted to original
80e1b2e 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Use getContextData instead of getContextMap
74672e6 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Refactors server log handling for improved efficiency
c28a705 
Changes the ArrayAppender to construct a ServerLogItem directly
instead of passing individual log properties.

The ServerLogProvider now accepts a ServerLogItem, extracts the log
properties, adds the server ID and log ID, and then passes the log
item to the log controller.

This change simplifies the code and makes it more efficient by
reducing the number of parameters passed and centralizing the
creation of the ServerLogItem.

Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel @mgaffigan
Sets default values for ServerLogItem
53a85d9 
Ensures that the ServerLogItem properties are initialized with default values when retrieving them from the context.
This prevents null pointer exceptions or unexpected behavior when these properties are not explicitly set in the context.

Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@mgaffigan mgaffigan force-pushed the feature/logging-improvements branch from 2482499 to 53a85d9 Compare November 24, 2025 19:19
@NicoPiel
Implemented old ServerLogItem + an attributes map
278d2b3 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel NicoPiel force-pushed the feature/logging-improvements branch from a418b01 to 278d2b3 Compare November 24, 2025 20:08
@NicoPiel
Removed unused imports
b1623c9 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel NicoPiel force-pushed the feature/logging-improvements branch from 469b1c1 to b1623c9 Compare November 24, 2025 20:19
mgaffigan
mgaffigan requested changes Nov 24, 2025
View reviewed changes
@NicoPiel
Revert ServerLogClient.java
6c5fbc6 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel
Update ServerLogClient.java
9f833e3 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel
Exclude channel attributes from server log JSON
a7b0296 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel
Revert SwaggerExamplesServlet
9d0946b 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel
Line wrap
d0b358f 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel
Removed unused import
b272f5d 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel
Added channel name to DestinationChain higher up the call chain
6ec3d04 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel
Removed unncessary null checks
22b0669 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@NicoPiel
Omit unnecessary null check
f1f1f4f 
Signed-off-by: Nico Piel <nico.piel@hotmail.de>
@mgaffigan mgaffigan changed the title Logging improvements Include Channel Name in server log Nov 26, 2025
@pacmano1 pacmano1 requested a review from Copilot December 9, 2025 22:22
Copilot AI reviewed Dec 9, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds channel name information to server logs by propagating channel context through Log4j's ThreadContext mechanism. The implementation spans three main components: server-side logging infrastructure, the Donkey engine threading model, and the client UI.

Key changes:

  • Modified ServerLogItem to store channel information in an attributes map with convenient getter/setter methods
  • Updated all channel-related thread entry points to populate ThreadContext with channel ID and name using CloseableThreadContext
  • Enhanced the server log UI table to display a new "Channel" column

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 12 comments.

Show a summary per file
File Description
server/src/com/mirth/connect/server/util/javascript/JavaScriptTask.java Added ThreadContext population with channel info in JavaScript task execution
server/src/com/mirth/connect/plugins/serverlog/ServerLogProvider.java Updated method signature to accept attributes map for channel information
server/src/com/mirth/connect/plugins/serverlog/ServerLogItem.java Added attributes map to store channel data with dedicated getter/setter methods
server/src/com/mirth/connect/plugins/serverlog/ArrayAppender.java Modified to extract context data from Log4j events and pass to provider
donkey/src/main/java/com/mirth/connect/donkey/server/channel/DestinationConnector.java Wrapped queue thread execution with ThreadContext for channel info
donkey/src/main/java/com/mirth/connect/donkey/server/channel/DestinationChainProvider.java Added channelName field with getter/setter
donkey/src/main/java/com/mirth/connect/donkey/server/channel/DestinationChain.java Added ThreadContext population in chain execution threads
donkey/src/main/java/com/mirth/connect/donkey/server/channel/Channel.java Updated to set channel name on chain providers and populate ThreadContext in dispatch/queue threads
client/src/com/mirth/connect/plugins/serverlog/ServerLogPanel.java Added "Channel" column to server log table and adjusted column indices

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tonygermano tonygermano added the enhancement New feature or request label Dec 12, 2025
@NicoPiel NicoPiel requested review from a team, gibson9583, jonbartels, kayyagari, kpalang, pacmano1, ssrowe and tonygermano and removed request for a team March 13, 2026 20:31
pacmano1
pacmano1 requested changes Mar 14, 2026
View reviewed changes
Copy link
Contributor

@pacmano1 pacmano1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Firstly, I do like this the change!

However for those of us who already prepend channelName to log messages, IMHO this should be implemtned as an optional feature configurable by default to off via mirth.properties

@mgaffigan
Copy link
Contributor

mgaffigan commented Mar 14, 2026

Firstly, I do like this the change!

However for those of us who already prepend channelName to log messages, IMHO this should be implemtned as an optional feature configurable by default to off via mirth.properties

@pacmano1, that would make this hard to discover for newcomers and the majority of users who don't log servername.

There only seems to be a cosmetic problem if it is enabled by default, and a usability problem if disabled.

Defaults should be based on best practice for the typical new user.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mgaffigan mgaffigan mgaffigan approved these changes

Copilot code review Copilot Copilot left review comments

@pacmano1 pacmano1 pacmano1 requested changes

@kayyagari kayyagari Awaiting requested review from kayyagari kayyagari was automatically assigned from OpenIntegrationEngine/maintainers

@gibson9583 gibson9583 Awaiting requested review from gibson9583 gibson9583 was automatically assigned from OpenIntegrationEngine/maintainers

@ssrowe ssrowe Awaiting requested review from ssrowe ssrowe was automatically assigned from OpenIntegrationEngine/maintainers

@kpalang kpalang Awaiting requested review from kpalang kpalang was automatically assigned from OpenIntegrationEngine/maintainers

@jonbartels jonbartels Awaiting requested review from jonbartels jonbartels was automatically assigned from OpenIntegrationEngine/maintainers

@tonygermano tonygermano Awaiting requested review from tonygermano tonygermano was automatically assigned from OpenIntegrationEngine/maintainers

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@NicoPiel @mgaffigan @pacmano1 @tonygermano